/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the License at the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apereo.portal.security;

import java.io.Serializable;

/**
 * Our OpaqueCredentials interface stores password or passphrase information for authentication. The
 * same structure stores information that can potentially be used post-authentication to keep
 * Kerberos TGT's or other useful security context authenticators.
 */
public interface IOpaqueCredentials extends Serializable {

    /**
     * Set the credentials value.
     *
     * @param credentials A string of bytes that represents an authenticator.
     */
    public void setCredentials(byte[] credentials);

    /**
     * Set the credentials value.
     *
     * @param credentials A Java String that contains an authenticator such as a passphrase that is
     *     typically represented by a locale-specific text string.
     */
    public void setCredentials(String credentials);
}
